LINE Pay決済

LINE Pay決済 随時決済 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却

EntryTranLinepay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID
JobCd 必須
処理区分

AUTH：仮売上
CAPTURE：即時売上

Amount 必須 半角数字8桁
利用金額

Tax 半角数字7桁
税送料

税送料を指定した場合は、利用金額＋税送料が決済金額となります。

URL
/payment/EntryTranLinepay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000
レスポンス
正常
OrderID 必須 半角英数記号27桁
オーダーID
AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranLinepay 決済実行

決済処理を行い結果を返却します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
OrderID 必須 半角英数記号27桁
オーダーID
ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

ClientFieldFlag 半角数字1桁
加盟店自由項目返却フラグ

以下のいずれかを設定します。
0：返却しない(デフォルト)
1：返却する

ProductName 必須 全半角4000桁
商品名
PaymentType 必須 半角英字10桁
決済タイプ

下記を指定してください。
SETTLEMENT：随時決済をする

SettlementRegKey 必須 半角英数15桁
決済用RegKey

都度決済＋利用承諾で発行したRegkeyを指定します。

URL
/payment/ExecTranLinepay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive/success&ErrorRcvURL=https://example.com/receive/error&ProductName=Product&PaymentType=REGISTER
レスポンス
正常
OrderID 必須 半角英数記号27桁
オーダーID
Status 必須 半角英数11桁
ステータス

該当取引の取引状態を返却します。
処理成功時
・AUTH
・CAPTURE
処理失敗時
・UNPROCESSED

TranDate 必須 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

TranID 半角英数19桁
LINE PayトランザクションID

LINE Payセンターで管理している取引番号を返却します。
CheckString 必須 半角英数記号64桁
改ざんチェック文字列

OrderID,AccessID,ShopID,ShopPass,Statusを連結しSHA256ハッシュした値を返却します。
ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CAPTURE&TranDate=20210315110252&TranID=2021031549899044710&PayMethod=CREDIT_CARD&CheckString=a50a7013eae192ecf86afbbb36f91bfac1e59ea1bb1b9c9da4649a9fc9121e02
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

LinepayCancelReturn キャンセル・返品

決済が完了した取引に対して決済内容のキャンセル・返品を行います。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
CancelAmount 必須 半角数字8桁
キャンセル金額
CancelTax 半角数字7桁
キャンセル税送料

キャンセル金額＋キャンセル税送料をキャンセル金額とします。（1円以上）
仮売上をキャンセルする場合、キャンセル金額とキャンセル税送料はオーソリ時の金額を指定してください。
即時売上、実売上を返品する場合、売上確定金額の一部返品が可能です。
例）仮売上525円よりキャンセル→キャンセル金額：525円
実売上525円より210円分返品→キャンセル金額：210円

URL
/payment/LinepayCancelReturn.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&CancelAmount=500
レスポンス
正常
OrderID 必須 半角英数記号27桁
オーダーID

AccessID 必須 半角英数32桁 固定
取引ID

【決済キャンセル・返品】呼び出し時に指定した値を返却します。

Status 必須
現状態

キャンセル・返品成功時は以下のステータスが返却されます。
・CANCEL：キャンセル
・RETURN：返品

キャンセル・返品失敗時、または一部返品時はキャンセル・返品処理前のステータスが返却されます。

Amount 必須 半角数字8桁
利用金額

利用金額からキャンセル金額を減算した結果を返却します。

例）利用金額5,000円よりキャンセル金額3,000円→利用金額：2,000円

Tax 必須 半角数字7桁
税送料

税送料からキャンセル税送料を減算した結果を返却します。

例）税送料250円よりキャンセル税送料150円→税送料：100円

CancelAmount 必須 半角数字8桁
キャンセル金額

CancelTax 必須 半角数字7桁
キャンセル税送料

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&Status=CANCEL&Amount=0&Tax=0&CancelAmount=1000&CancelTax=100
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

LinepaySales 実売上

仮売上の決済に対して実売上を行います。尚、実行時に仮売上時との金額チェックを行います。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
Amount 必須 半角数字8桁
利用金額

Tax 半角数字7桁
税送料

利用金額＋税送料が売上金額となります（1円以上）
※0円の場合はエラーとします。
※オーソリ時より大きい金額の場合はエラーとします。
※オーソリ時と異なる金額の場合は、指定された金額で売上を確定します。

URL
/payment/LinepaySales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000
レスポンス
正常
OrderID 必須 半角英数記号27桁
オーダーID
AccessID 必須 半角英数32桁 固定
取引ID

【実売上】呼び出し時に指定した値を返却します。

Status 必須
現状態

売上確定成功時は以下のステータスが返却されます。
・SALES：実売上
売上確定失敗時は売上確定処理前のステータスが返却されます。

Amount 必須 半角数字8桁
利用金額

Tax 必須 半角数字7桁
税送料

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&Status=SALES&Amount=1000&Tax=100
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID
PayType 必須 半角数字2桁
決済方法

20：LINE Pay決済

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=20
レスポンス
正常
Status 必須
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
PAYSTART：決済開始
PAYCANCEL：決済中止
PAYFAIL：決済失敗
AUTH：仮売上
SALES：実売上
CAPTURE：即時売上
CANCEL：キャンセル
RETURN：返品
EXPIRED：期限切れ

ProcessDate 必須 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

JobCd 必須
処理区分

AUTH：仮売上
SALES：実売上
CAPTURE：即時売上
CANCEL：キャンセル
RETURN：返品

AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
Amount 必須 半角数字8桁
利用金額
Tax 必須 半角数字7桁
税送料
SiteID 半角英数13桁
サイトID

未使用項目

MemberID 半角英数60桁
会員ID

未使用項目

Currency 半角英字3桁
通貨コード
TranID 半角英数19桁
LINE PayトランザクションID

ClientField1 必須 全半角100バイト
加盟店自由項目1

ClientField2 必須 全半角100バイト
加盟店自由項目2

ClientField3 必須 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

20：LINE Pay

LinepayProductName 全半角4000桁
LINE Pay商品名
LinepayPayMethod 半角英数20桁
支払方法

決済に使用されたLINE Pay決済の支払手段を返却します。

LinepayCancelAmount 半角数字8桁
キャンセル金額
LinepayCancelTax 半角数字8桁
キャンセル税送料
LinepayRegKey 半角英数15桁
RegKey

空を返却します。
LinepaySettlementRegKey 半角英数15桁
決済用RegKey

【決済実行】で指定したRegKeyを返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=SALES&ProcessDate=20210308125035&JobCd=SALES&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=100&SiteID=&MemberID=&Currency=&TranID=&ClientField1=&ClientField2=&ClientField3=&PayType=20&LinepayProductName=test&LinepayPayMethod=&LinepayCancelAmount=&LinepayCancelTax=&LinepayRegKey=&LinepaySettlementRegKey=
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001